<html>
<head>
<title>Package Sticky_auth Element Index</title>
<link rel="stylesheet" type="text/css" href="media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">Sticky_auth</td>
  </tr>
  <tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                    
                              		  [ <a href="classtrees_Sticky_auth.html" class="menu">class tree: Sticky_auth</a> ]
		  [ <a href="elementindex_Sticky_auth.html" class="menu">index: Sticky_auth</a> ]
		  	    [ <a href="elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="li_Sticky_auth.html">Sticky_auth</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="Sticky_auth/_sticky_auth.php.html">		sticky_auth.php
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="Sticky_auth/Sticky_auth.html">Sticky_auth</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<a name="top"></a>
<h1>Element index for package Sticky_auth</h1>
	[ <a href="elementindex_Sticky_auth.html#a">a</a> ]
	[ <a href="elementindex_Sticky_auth.html#c">c</a> ]
	[ <a href="elementindex_Sticky_auth.html#e">e</a> ]
	[ <a href="elementindex_Sticky_auth.html#g">g</a> ]
	[ <a href="elementindex_Sticky_auth.html#h">h</a> ]
	[ <a href="elementindex_Sticky_auth.html#l">l</a> ]
	[ <a href="elementindex_Sticky_auth.html#r">r</a> ]
	[ <a href="elementindex_Sticky_auth.html#s">s</a> ]
	[ <a href="elementindex_Sticky_auth.html#t">t</a> ]
	[ <a href="elementindex_Sticky_auth.html#u">u</a> ]
	[ <a href="elementindex_Sticky_auth.html#v">v</a> ]
	[ <a href="elementindex_Sticky_auth.html#_">_</a> ]

  <hr />
	<a name="_"></a>
	<div>
		<h2>_</h2>
		<dl>
							<dt><b>__construct</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#method__construct">Sticky_auth::__construct()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Constructor. Loads sticky_auth config and sets a few initial vars.</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="a"></a>
	<div>
		<h2>a</h2>
		<dl>
							<dt><b>activate_forgotten_password</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodactivate_forgotten_password">Sticky_auth::activate_forgotten_password()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Start the first step of the forgotten password process. Returns a boolean value signifying email sending success.</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="c"></a>
	<div>
		<h2>c</h2>
		<dl>
							<dt><b>change_password</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodchange_password">Sticky_auth::change_password()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Change a users password, will fail if the old password doesn't match  the new one</dd>
							<dt><b>compare_password_with_users</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodcompare_password_with_users">Sticky_auth::compare_password_with_users()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Compares two passwords if they are the same returns true</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="e"></a>
	<div>
		<h2>e</h2>
		<dl>
							<dt><b>email_exists</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodemail_exists">Sticky_auth::email_exists()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Check if an email is already in use</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="g"></a>
	<div>
		<h2>g</h2>
		<dl>
							<dt><b>generate_salt</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodgenerate_salt">Sticky_auth::generate_salt()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Generate a random salt string used in hashing passwords</dd>
							<dt><b>get_meta</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodget_meta">Sticky_auth::get_meta()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Gets the meta data for the specified user</dd>
							<dt><b>get_user_data</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodget_user_data">Sticky_auth::get_user_data()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Get the user data (data stored in the users table opposed to the meta table)</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="h"></a>
	<div>
		<h2>h</h2>
		<dl>
							<dt><b>hash_password</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodhash_password">Sticky_auth::hash_password()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Hash and salt a password</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="l"></a>
	<div>
		<h2>l</h2>
		<dl>
							<dt><b>logged_in</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodlogged_in">Sticky_auth::logged_in()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Is the user logged in or not?</dd>
							<dt><b>login</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodlogin">Sticky_auth::login()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Login a user, compares provided username and password</dd>
							<dt><b>logout</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodlogout">Sticky_auth::logout()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Logout a user</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="r"></a>
	<div>
		<h2>r</h2>
		<dl>
							<dt><b>redirect_if_not_logged_in</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodredirect_if_not_logged_in">Sticky_auth::redirect_if_not_logged_in()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Redirects the user to the login page (by default) if they are not logged in</dd>
							<dt><b>register</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodregister">Sticky_auth::register()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Register a user</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="s"></a>
	<div>
		<h2>s</h2>
		<dl>
							<dt><b>$salt_length</b></dt>
				<dd>in file sticky_auth.php, variable <a href="Sticky_auth/Sticky_auth.html#var$salt_length">Sticky_auth::$salt_length</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The length of salt used in passwords.</dd>
							<dt><b>send_email</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodsend_email">Sticky_auth::send_email()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Sends an email basically a wrapper for the email library</dd>
							<dt><b>send_new_password</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodsend_new_password">Sticky_auth::send_new_password()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;After the new password has been activated send an email with a new password. Returns a boolean value signifying email sending success.</dd>
							<dt><b>Sticky_auth</b></dt>
				<dd>in file sticky_auth.php, class <a href="Sticky_auth/Sticky_auth.html">Sticky_auth</a><br>&nbsp;&nbsp;&nbsp;&nbsp;The sticky_auth model class</dd>
							<dt><b>sticky_auth.php</b></dt>
				<dd>procedural page <a href="Sticky_auth/_sticky_auth.php.html">sticky_auth.php</a></dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="t"></a>
	<div>
		<h2>t</h2>
		<dl>
							<dt><b>$tables</b></dt>
				<dd>in file sticky_auth.php, variable <a href="Sticky_auth/Sticky_auth.html#var$tables">Sticky_auth::$tables</a><br>&nbsp;&nbsp;&nbsp;&nbsp;An array of tables used in sticky</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="u"></a>
	<div>
		<h2>u</h2>
		<dl>
							<dt><b>update_email</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodupdate_email">Sticky_auth::update_email()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Update a users email address</dd>
							<dt><b>update_meta</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodupdate_meta">Sticky_auth::update_meta()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Updates the meta data for the specified user</dd>
							<dt><b>username_exists</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodusername_exists">Sticky_auth::username_exists()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Check if a username is already in use</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
  <hr />
	<a name="v"></a>
	<div>
		<h2>v</h2>
		<dl>
							<dt><b>valid_forgotten_password_key</b></dt>
				<dd>in file sticky_auth.php, method <a href="Sticky_auth/Sticky_auth.html#methodvalid_forgotten_password_key">Sticky_auth::valid_forgotten_password_key()</a><br>&nbsp;&nbsp;&nbsp;&nbsp;Returns true if the provided key (generated in step 1 of password reset) is valid</dd>
					</dl>
	</div>
	<a href="elementindex_Sticky_auth.html#top">top</a><br>
        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 08 Feb 2009 23:46:16 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.2</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>